<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkColorChooser: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="SelectorWidgets.html" title="Selector Widgets and Dialogs">
<link rel="prev" href="SelectorWidgets.html" title="Selector Widgets and Dialogs">
<link rel="next" href="GtkColorButton.html" title="GtkColorButton">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GtkColorChooser.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkColorChooser.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
                  <a href="#GtkColorChooser.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span> 
                  <a href="#GtkColorChooser.implementations" class="shortcut">Known Implementations</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GtkColorChooser.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#GtkColorChooser.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="SelectorWidgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="SelectorWidgets.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkColorButton.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkColorChooser"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkColorChooser.top_of_page"></a>GtkColorChooser</span></h2>
<p>GtkColorChooser — Interface implemented by widgets for choosing colors</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkColorChooser.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkColorChooser.html#gtk-color-chooser-get-rgba" title="gtk_color_chooser_get_rgba ()">gtk_color_chooser_get_rgba</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkColorChooser.html#gtk-color-chooser-set-rgba" title="gtk_color_chooser_set_rgba ()">gtk_color_chooser_set_rgba</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkColorChooser.html#gtk-color-chooser-get-use-alpha" title="gtk_color_chooser_get_use_alpha ()">gtk_color_chooser_get_use_alpha</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkColorChooser.html#gtk-color-chooser-set-use-alpha" title="gtk_color_chooser_set_use_alpha ()">gtk_color_chooser_set_use_alpha</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkColorChooser.html#gtk-color-chooser-add-palette" title="gtk_color_chooser_add_palette ()">gtk_color_chooser_add_palette</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkColorChooser.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">GdkRGBA</span> *</td>
<td class="property_name"><a class="link" href="GtkColorChooser.html#GtkColorChooser--rgba" title="The “rgba” property">rgba</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkColorChooser.html#GtkColorChooser--use-alpha" title="The “use-alpha” property">use-alpha</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkColorChooser.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkColorChooser.html#GtkColorChooser-color-activated" title="The “color-activated” signal">color-activated</a></td>
<td class="signal_flags">Run First</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkColorChooser.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GtkColorChooser.html#GtkColorChooser-struct" title="GtkColorChooser">GtkColorChooser</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkColorChooser.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
    <span class="lineart">╰──</span> GtkColorChooser
</pre>
</div>
<div class="refsect1">
<a name="GtkColorChooser.prerequisites"></a><h2>Prerequisites</h2>
<p>
GtkColorChooser requires
 GObject.</p>
</div>
<div class="refsect1">
<a name="GtkColorChooser.implementations"></a><h2>Known Implementations</h2>
<p>
GtkColorChooser is implemented by
 <a class="link" href="GtkColorButton.html" title="GtkColorButton">GtkColorButton</a>,  <a class="link" href="GtkColorChooserDialog.html" title="GtkColorChooserDialog">GtkColorChooserDialog</a> and  <a class="link" href="GtkColorChooserWidget.html" title="GtkColorChooserWidget">GtkColorChooserWidget</a>.</p>
</div>
<div class="refsect1">
<a name="GtkColorChooser.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkColorChooser.description"></a><h2>Description</h2>
<p><a class="link" href="GtkColorChooser.html" title="GtkColorChooser"><span class="type">GtkColorChooser</span></a> is an interface that is implemented by widgets
for choosing colors. Depending on the situation, colors may be
allowed to have alpha (translucency).</p>
<p>In GTK+, the main widgets that implement this interface are
<a class="link" href="GtkColorChooserWidget.html" title="GtkColorChooserWidget"><span class="type">GtkColorChooserWidget</span></a>, <a class="link" href="GtkColorChooserDialog.html" title="GtkColorChooserDialog"><span class="type">GtkColorChooserDialog</span></a> and <a class="link" href="GtkColorButton.html" title="GtkColorButton"><span class="type">GtkColorButton</span></a>.</p>
</div>
<div class="refsect1">
<a name="GtkColorChooser.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-color-chooser-get-rgba"></a><h3>gtk_color_chooser_get_rgba ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_color_chooser_get_rgba (<em class="parameter"><code><a class="link" href="GtkColorChooser.html" title="GtkColorChooser"><span class="type">GtkColorChooser</span></a> *chooser</code></em>,
                            <em class="parameter"><code><span class="type">GdkRGBA</span> *color</code></em>);</pre>
<p>Gets the currently-selected color.</p>
<div class="refsect3">
<a name="gtk-color-chooser-get-rgba.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>chooser</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkColorChooser.html" title="GtkColorChooser"><span class="type">GtkColorChooser</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>a <span class="type">GdkRGBA</span> to fill in with the current color. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-4.html#api-index-3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-color-chooser-set-rgba"></a><h3>gtk_color_chooser_set_rgba ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_color_chooser_set_rgba (<em class="parameter"><code><a class="link" href="GtkColorChooser.html" title="GtkColorChooser"><span class="type">GtkColorChooser</span></a> *chooser</code></em>,
                            <em class="parameter"><code>const <span class="type">GdkRGBA</span> *color</code></em>);</pre>
<p>Sets the color.</p>
<div class="refsect3">
<a name="gtk-color-chooser-set-rgba.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>chooser</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkColorChooser.html" title="GtkColorChooser"><span class="type">GtkColorChooser</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>the new color</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-4.html#api-index-3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-color-chooser-get-use-alpha"></a><h3>gtk_color_chooser_get_use_alpha ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_color_chooser_get_use_alpha (<em class="parameter"><code><a class="link" href="GtkColorChooser.html" title="GtkColorChooser"><span class="type">GtkColorChooser</span></a> *chooser</code></em>);</pre>
<p>Returns whether the color chooser shows the alpha channel.</p>
<div class="refsect3">
<a name="gtk-color-chooser-get-use-alpha.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>chooser</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkColorChooser.html" title="GtkColorChooser"><span class="type">GtkColorChooser</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-color-chooser-get-use-alpha.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the color chooser uses the alpha channel,
<code class="literal">FALSE</code> if not</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-4.html#api-index-3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-color-chooser-set-use-alpha"></a><h3>gtk_color_chooser_set_use_alpha ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_color_chooser_set_use_alpha (<em class="parameter"><code><a class="link" href="GtkColorChooser.html" title="GtkColorChooser"><span class="type">GtkColorChooser</span></a> *chooser</code></em>,
                                 <em class="parameter"><code><span class="type">gboolean</span> use_alpha</code></em>);</pre>
<p>Sets whether or not the color chooser should use the alpha channel.</p>
<div class="refsect3">
<a name="gtk-color-chooser-set-use-alpha.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>chooser</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkColorChooser.html" title="GtkColorChooser"><span class="type">GtkColorChooser</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>use_alpha</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if color chooser should use alpha channel, <code class="literal">FALSE</code> if not</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-4.html#api-index-3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-color-chooser-add-palette"></a><h3>gtk_color_chooser_add_palette ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_color_chooser_add_palette (<em class="parameter"><code><a class="link" href="GtkColorChooser.html" title="GtkColorChooser"><span class="type">GtkColorChooser</span></a> *chooser</code></em>,
                               <em class="parameter"><code><a class="link" href="gtk3-Standard-Enumerations.html#GtkOrientation" title="enum GtkOrientation"><span class="type">GtkOrientation</span></a> orientation</code></em>,
                               <em class="parameter"><code><span class="type">gint</span> colors_per_line</code></em>,
                               <em class="parameter"><code><span class="type">gint</span> n_colors</code></em>,
                               <em class="parameter"><code><span class="type">GdkRGBA</span> *colors</code></em>);</pre>
<p>Adds a palette to the color chooser. If <em class="parameter"><code>orientation</code></em>
 is horizontal,
the colors are grouped in rows, with <em class="parameter"><code>colors_per_line</code></em>
 colors
in each row. If <em class="parameter"><code>horizontal</code></em>
 is <code class="literal">FALSE</code>, the colors are grouped
in columns instead.</p>
<p>The default color palette of <a class="link" href="GtkColorChooserWidget.html" title="GtkColorChooserWidget"><span class="type">GtkColorChooserWidget</span></a> has
27 colors, organized in columns of 3 colors. The default gray
palette has 9 grays in a single row.</p>
<p>The layout of the color chooser widget works best when the
palettes have 9-10 columns.</p>
<p>Calling this function for the first time has the
side effect of removing the default color and gray palettes
from the color chooser.</p>
<p>If <em class="parameter"><code>colors</code></em>
 is <code class="literal">NULL</code>, removes all previously added palettes.</p>
<div class="refsect3">
<a name="gtk-color-chooser-add-palette.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>chooser</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkColorChooser.html" title="GtkColorChooser"><span class="type">GtkColorChooser</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>orientation</p></td>
<td class="parameter_description"><p><a class="link" href="gtk3-Standard-Enumerations.html#GTK-ORIENTATION-HORIZONTAL:CAPS"><code class="literal">GTK_ORIENTATION_HORIZONTAL</code></a> if the palette should
be displayed in rows, <a class="link" href="gtk3-Standard-Enumerations.html#GTK-ORIENTATION-VERTICAL:CAPS"><code class="literal">GTK_ORIENTATION_VERTICAL</code></a> for columns</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>colors_per_line</p></td>
<td class="parameter_description"><p>the number of colors to show in each row/column</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_colors</p></td>
<td class="parameter_description"><p>the total number of elements in <em class="parameter"><code>colors</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>colors</p></td>
<td class="parameter_description"><p>the colors of the palette, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_colors]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-4.html#api-index-3.4">3.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkColorChooser.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkColorChooser-struct"></a><h3>GtkColorChooser</h3>
<pre class="programlisting">typedef struct _GtkColorChooser GtkColorChooser;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkColorChooser.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkColorChooser--rgba"></a><h3>The <code class="literal">“rgba”</code> property</h3>
<pre class="programlisting">  “rgba”                     <span class="type">GdkRGBA</span> *</pre>
<p>The ::rgba property contains the currently selected color,
as a <span class="type">GdkRGBA</span> struct. The property can be set to change
the current selection programmatically.</p>
<p>Owner: GtkColorChooser</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="api-index-3-4.html#api-index-3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkColorChooser--use-alpha"></a><h3>The <code class="literal">“use-alpha”</code> property</h3>
<pre class="programlisting">  “use-alpha”                <span class="type">gboolean</span></pre>
<p>When ::use-alpha is <code class="literal">TRUE</code>, colors may have alpha (translucency)
information. When it is <code class="literal">FALSE</code>, the <span class="type">GdkRGBA</span> struct obtained
via the <a class="link" href="GtkColorChooser.html#GtkColorChooser--rgba" title="The “rgba” property"><span class="type">“rgba”</span></a> property will be forced to have
alpha == 1.</p>
<p>Implementations are expected to show alpha by rendering the color
over a non-uniform background (like a checkerboard pattern).</p>
<p>Owner: GtkColorChooser</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
<p class="since">Since: <a class="link" href="api-index-3-4.html#api-index-3.4">3.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkColorChooser.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkColorChooser-color-activated"></a><h3>The <code class="literal">“color-activated”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkColorChooser.html" title="GtkColorChooser"><span class="type">GtkColorChooser</span></a> *chooser,
               <span class="type">GdkRGBA</span>         *color,
               <span class="type">gpointer</span>         user_data)</pre>
<p>Emitted when a color is activated from the color chooser.
This usually happens when the user clicks a color swatch,
or a color is selected and the user presses one of the keys
Space, Shift+Space, Return or Enter.</p>
<div class="refsect3">
<a name="GtkColorChooser-color-activated.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>chooser</p></td>
<td class="parameter_description"><p>the object which received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>the color</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since: <a class="link" href="api-index-3-4.html#api-index-3.4">3.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkColorChooser.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkColorChooserDialog.html" title="GtkColorChooserDialog"><span class="type">GtkColorChooserDialog</span></a>, <a class="link" href="GtkColorChooserWidget.html" title="GtkColorChooserWidget"><span class="type">GtkColorChooserWidget</span></a>, <a class="link" href="GtkColorButton.html" title="GtkColorButton"><span class="type">GtkColorButton</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>